Skip to content

docs: update gateway helm reference#537

Merged
NomadXD merged 2 commits intoopenchoreo:mainfrom
NomadXD:main
Mar 30, 2026
Merged

docs: update gateway helm reference#537
NomadXD merged 2 commits intoopenchoreo:mainfrom
NomadXD:main

Conversation

@NomadXD
Copy link
Copy Markdown
Contributor

@NomadXD NomadXD commented Mar 30, 2026

Purpose

This PR updates the gateway helm reference in the openchoreo data plane helm chart. Previous reference is outdated.

Related Issues

Include any related issues that are resolved by this PR.

Checklist

  • Updated sidebars.ts if adding a new documentation page
  • Run npm run start to preview the changes locally
  • Run npm run build to ensure the build passes without errors
  • Verified all links are working (no broken links)

Signed-off-by: Lahiru De Silva <lahirude@wso2.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 30, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: c80293ea-57cf-4f35-bf6f-c6da63b83feb

📥 Commits

Reviewing files that changed from the base of the PR and between d16a010 and d6b7cfd.

📒 Files selected for processing (1)
  • docs/reference/helm/data-plane.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/reference/helm/data-plane.mdx

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Reworked Gateway docs to focus on the Kubernetes Gateway API Gateway CR.
    • Removed previous gateway-controller and agentgateway configuration parameters from the guide.
    • Introduced a consolidated gateway.infrastructure object for configuring load balancer annotations and defaults.
    • Updated parameter lists and table headers to reflect the new, simplified configuration surface.

Walkthrough

Rewrote the Gateway documentation in the Helm chart to remove gateway-controller and agentgateway configuration entries and replaced the previous gateway.infrastructure.labels with a consolidated gateway.infrastructure object described for Service load balancer annotations.

Changes

Cohort / File(s) Summary
Helm Chart Documentation
docs/reference/helm/data-plane.mdx
Replaced broad KGateway/gateway-controller and agentgateway parameter docs with a focused Kubernetes Gateway API Gateway CR reference. Removed controller/agentgateway parameters (controller image, replicas, resources, ports, service type, agentgateway enablement, etc.). Introduced a consolidated gateway.infrastructure object for LB annotations and changed example/default to nested labels under that object.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: update gateway helm reference' directly summarizes the main change of updating gateway documentation in the Helm reference section.
Description check ✅ Passed The description follows the required template with Purpose and Checklist sections present; however, the Purpose section lacks detail about what specifically changed in the gateway configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/reference/helm/data-plane.mdx (1)

1-1: ⚠️ Potential issue | 🟡 Minor

Fix Prettier formatting issues before merging.

The pipeline reports code style issues detected by Prettier. Run npm run format or npx prettier --write docs/reference/helm/data-plane.mdx to fix the formatting.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/reference/helm/data-plane.mdx` at line 1, Prettier reported formatting
problems in the frontmatter of docs/reference/helm/data-plane.mdx; run the
formatter (npm run format or npx prettier --write
docs/reference/helm/data-plane.mdx), review and stage the updated file, then
commit the formatted changes so the CI style check passes.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@docs/reference/helm/data-plane.mdx`:
- Line 1: Prettier reported formatting problems in the frontmatter of
docs/reference/helm/data-plane.mdx; run the formatter (npm run format or npx
prettier --write docs/reference/helm/data-plane.mdx), review and stage the
updated file, then commit the formatted changes so the CI style check passes.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 2340caa6-7df4-47fb-9073-bafe9a88012e

📥 Commits

Reviewing files that changed from the base of the PR and between c37a0cf and d16a010.

⛔ Files ignored due to path filters (1)
  • versioned_docs/version-v1.0.x/reference/helm/data-plane.mdx is excluded by !versioned_docs/**
📒 Files selected for processing (1)
  • docs/reference/helm/data-plane.mdx

Signed-off-by: Lahiru De Silva <lahirude@wso2.com>
@NomadXD NomadXD merged commit af1a33f into openchoreo:main Mar 30, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants